Bring the ice-demos Gradle in-line with the ice Repo Gradle
#654
Conversation
| Push-Location $_.DirectoryName | ||
| Write-Host "Building in $($_.DirectoryName)..." | ||
| & ./gradlew rewriteDryRun | ||
| & ./gradlew rewriteDryRun --no-parallel --no-configuration-cache |
There was a problem hiding this comment.
rewriteDryRun can't be run in parallel or with the configuration cache.
| "**/*.kt", | ||
| ) | ||
| } | ||
|
|
There was a problem hiding this comment.
Quality of life - so rewrite prints it's suggestions to the build output so they can be picked up.
| <property name="allowNonPrintableEscapes" value="true"/> | ||
| </module> | ||
|
|
||
| <module name="UnusedImports"/> |
There was a problem hiding this comment.
No reason not to check for this.
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the Java linting configuration and workflow to improve code quality checks. It adds unused import detection to Checkstyle, enhances the OpenRewrite dry run behavior to better communicate required changes, and improves the CI workflow reliability.
- Added
UnusedImportsmodule to Checkstyle configuration for detecting unused imports - Enhanced
rewriteDryRuntask to display required changes and fail builds in CI when changes are needed - Updated CI workflow to run
rewriteDryRunwith--no-paralleland--no-configuration-cacheflags
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| java/config/checkstyle/checkstyle.xml | Added UnusedImports module to detect unused Java imports |
| java/build-logic/src/main/kotlin/zeroc-linting.gradle.kts | Enhanced rewriteDryRun task with report cleanup, change display, and CI failure logic |
| .github/workflows/java.yml | Added --no-parallel and --no-configuration-cache flags to rewriteDryRun command |
| doFirst { | ||
| // Delete the old report file if present | ||
| val reportFile = file(reportPath) | ||
| if (reportFile.exists()) { | ||
| reportFile.delete() | ||
| } | ||
| } | ||
|
|
||
| doLast { | ||
| if (file(reportPath).exists()) { |
There was a problem hiding this comment.
The property reportPath is accessed but not defined in this file. This will cause a compilation error unless reportPath is a property of RewriteDryRunTask. Verify that reportPath exists on the task or define it explicitly.
| doFirst { | |
| // Delete the old report file if present | |
| val reportFile = file(reportPath) | |
| if (reportFile.exists()) { | |
| reportFile.delete() | |
| } | |
| } | |
| doLast { | |
| if (file(reportPath).exists()) { | |
| // Define the path to the rewrite dry run report file | |
| val reportPath = project.layout.buildDirectory.file("rewrite/rewrite-dry-run.txt").get().asFile.toPath() | |
| doFirst { | |
| // Delete the old report file if present | |
| val reportFile = reportPath.toFile() | |
| if (reportFile.exists()) { | |
| reportFile.delete() | |
| } | |
| } | |
| doLast { | |
| if (reportPath.toFile().exists()) { |
There was a problem hiding this comment.
It's a property defined by the rewrite Task itself.
It's getter is defined here: https://github.com/openrewrite/rewrite-gradle-plugin/blob/363bbc7a63a2df4d8f78f33d6812e416ef9e77cf/plugin/src/main/java/org/openrewrite/gradle/RewriteDryRunTask.java#L32
To access them through gradle you omit the get prefix though.
2 participants
In the last week I've made some changes to the ice repo's gradle setup.
This PR copies the meaningful changes to the ice-demo repo to keep them in sync.
See zeroc-ice/ice#4616 and zeroc-ice/ice#4597